CIMPLICITY REST API Web Service
CIMPLICITY REST API Web Service / Filters Json Schema
Filters Json Schema
Description
An object which provides an interface for filters to read point configuration
Overview
Filters
An object which provides an interface for filters to read point configuration
HasAlarm : boolean
filters the list of points based on the presence of alarm configuration
PointID : string
provides a wild card string to filter points by their PointID.
DeviceID : string
Device ID for the point, where the point data originates. If the point is a global point, the device is "$GLOBAL". If the point is an equation point, the device is $DERIVED.
ResourceID : string
provides a wild card string to filter points by their ResourceID.
PointTypeID : string
Point Type ID of the point (UINT, REAL, etc.)
Description : string
provides a wild card string to filter points by their Description.
AccessFilter : string
The value for this filter is set to 'E' or 'e', while character * can be used. When specified will return enterpirse points.
Properties
NameDescriptionData Type
filters the list of points based on the presence of alarm configurationboolean
provides a wild card string to filter points by their PointID.string
Device ID for the point, where the point data originates. If the point is a global point, the device is "$GLOBAL". If the point is an equation point, the device is $DERIVED.string
provides a wild card string to filter points by their ResourceID.string
Point Type ID of the point (UINT, REAL, etc.)string
provides a wild card string to filter points by their Description.string
The value for this filter is set to 'E' or 'e', while character * can be used. When specified will return enterpirse points.string
See Also